Range
Function
This API is used to get the parameter range of Event Settings(cloud dedicated) > Notification.
Note:
The Range provides reference information for client UI input limits and API request limits. When sending Get and Set requests, the parameters must be strictly limited according to the Range, otherwise the request may be rejected by the device.
Request Message
Table 1
| Parameter | Range | Type | Description |
|---|---|---|---|
| channel | "CH1"... | string | Corresponding intelligent channel. |
| abilities | "FaceDetection", "HumanVehicle", "LicensePlate", "LineCrossing", "Intrusion", "Intrusion", "ExitRegion", "ObjectDetection", "CrossCounting", "CrossCounting", "QueueLength", "CrowdDensity", "RareSound", "MotionDetection", "VideoTampering" | array | Current intelligence. |
Sampel：
POST /API/Event/AlarmLinkage/Range HTTP/1.1
{
"version": "1.0",
"data": {
"channel": "CH1",
"ability": "HumanVehicle"
}
}
Response Message
Parameter Description
Table 2
| Parameter | Range | Type | Description |
|---|---|---|---|
| channel_info | JSON Object | Channel Info Object,see Table 3 for more information. |
Table 3
Channel Info Object
| Parameter | Range | Type | Description |
|---|---|---|---|
| CH1 | Json Object | Channel Object,see Table 4 for more information. | |
| IP_CH1 | Json Object | ||
| WIFI_CH1 | Json Object |
Table 4
Channel Object
| Parameter | Range | Type | Description |
|---|---|---|---|
| notification_settings | Json Object | notification_settings Object,see Table 5 for more information. |
Table 5
notification_settings Object
| Parameter | Range | Type | Description |
|---|---|---|---|
| URL1 | Json Object | URL Object,see Table 6 for more information. | |
| URL2 | Json Object | URL Object,see Table 6 for more information. | |
| URL3 | Json Object | URL Object,see Table 6 for more information. |
Table 6
URL Object
| Parameter | Range | Type | Description |
|---|---|---|---|
| enable | bool | Push switch. | |
| push_way | "HTTP", "HTTPS" | string | Push protocol. |
| trigger_interval | 0 ~ 900 | int | The interval time for alarm linkage push. |
| method | "GET", "POST" | string | Push method. |
| url | 0 ~ 511 | string | The network address to push. |
| username | 0 ~ 63 | string | Username Account. |
| password | 0 ~ 63 | string | Password. |
| password_empty | bool | Is the password empty. | |
| auth_enable | bool | Is user authentication enabled. | |
| btn_get_default_data | bool | Whether to display the Get Defaults button. | |
| limit_character | " " | string | Restricted characters. |
| base_enc_password | Json Object | encrypted password,see base_secondary_authentication for more information. |
Tips:
The response message of the Range request may not contain all the fields in the above table, and the fields not included indicate that the device does not support this parameter configuration.
Sample:
HTTP/1.1 200 OK
Content-Type: application/json
{
"result": "success",
"data": {
"channel_max": 8,
"channel_info": {
"type": "object",
"items": {"CH1": {
"type": "object",
"items": {"notification_settings": {
"type": "object",
"items": {
"URL1": {
"type": "object",
"items": {
"enable": {"type": "bool"},
"push_way": {
"type": "string",
"items": [
"HTTP",
"HTTPS"
]
},
"trigger_interval": {
"type": "int32",
"min": 0,
"max": 900
},
"method": {
"type": "string",
"items": [
"GET",
"POST"
]
},
"url": {
"type": "string",
"min_len": 0,
"max_len": 511
},
"username": {
"type": "string",
"min_len": 0,
"max_len": 63
},
"password": {
"type": "string",
"min_len": 0,
"max_len": 63
},
"password_empty": {"type": "bool"},
"auth_enable": {"type": "bool"}
}
},
"URL2": {
"type": "object",
"items": {
"enable": {"type": "bool"},
"push_way": {
"type": "string",
"items": [
"HTTP",
"HTTPS"
]
},
"trigger_interval": {
"type": "int32",
"min": 0,
"max": 900
},
"method": {
"type": "string",
"items": [
"GET",
"POST"
]
},
"url": {
"type": "string",
"min_len": 0,
"max_len": 511
},
"username": {
"type": "string",
"min_len": 0,
"max_len": 63
},
"password": {
"type": "string",
"min_len": 0,
"max_len": 63
},
"password_empty": {"type": "bool"},
"auth_enable": {"type": "bool"}
}
},
"URL3": {
"type": "object",
"items": {
"enable": {"type": "bool"},
"push_way": {
"type": "string",
"items": [
"HTTP",
"HTTPS"
]
},
"trigger_interval": {
"type": "int32",
"min": 0,
"max": 900
},
"method": {
"type": "string",
"items": [
"GET",
"POST"
]
},
"url": {
"type": "string",
"min_len": 0,
"max_len": 511
},
"username": {
"type": "string",
"min_len": 0,
"max_len": 63
},
"password": {
"type": "string",
"min_len": 0,
"max_len": 63
},
"password_empty": {"type": "bool"},
"auth_enable": {"type": "bool"}
}
}
}
}}
}}
},
"btn_get_default_data": true,
"limit_character": [
" ",
"
"
]
}
}
Error Code
See Response Messages Body and Common error_code for more information.